Skip to main content

Troubleshooting Guide

Common issues and their solutions when working with Example Component Library.

Build Issues​

Gradle Build Fails​

Symptoms​

  • ./gradlew build fails
  • Missing dependency errors
  • Compilation errors

Solutions​

  1. Check Java version:

    java -version  # Should be Java 17

  2. Update Gradle wrapper:

    ./gradlew wrapper --gradle-version=8.7

  3. Clean and rebuild:

    ./gradlew clean build

NPM Build Issues​

Symptoms​

  • npm install fails
  • Webpack errors
  • Missing dependencies

Solutions​

  1. Clear npm cache:

    npm cache clean --force

  2. Delete node_modules:

    rm -rf node_modules
    npm install

IDE Issues​

VS Code Java Problems​

Symptoms​

  • Missing Java imports
  • Red squiggles under valid code
  • Intellisense not working

Solutions​

  1. Regenerate project files:

    ./gradlew clean eclipse

  2. In VS Code:

    • Cmd/Ctrl + Shift + P
    • Type "Java: Clean Language Server Workspace"
    • Select "Restart and delete"

TypeScript Errors​

Symptoms​

  • TypeScript compilation errors
  • Missing type definitions

Solutions​

  1. Check TypeScript version:

    npm list typescript

  2. Update TypeScript:

    npm install --save-dev typescript@latest

Docker Issues​

Container Won't Start​

Symptoms​

  • docker-compose up fails
  • Port conflicts
  • Permission issues

Solutions​

  1. Check that the module was built before the container started, so build/Example-Component-Library.unsigned.modl exists

  2. If you publish the gateway port instead of using the Traefik proxy, check for port conflicts:

    lsof -i :8088

  3. Stop conflicting services:

    docker-compose down
    docker system prune

Module Changes Not Showing​

Symptoms​

  • Java, descriptor or schema changes don't appear after ./gradlew build

Solutions​

Ignition 8.3 loads modules only at gateway startup. Restart the gateway, then reopen the Designer:

docker compose -f docker/docker-compose.yml restart gateway

Still Need Help?​